home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Online / privoxy-3.0.0-stable / config next >
Text File  |  2002-10-27  |  30KB  |  1,050 lines
  1. #        Sample Configuration File for Privoxy v3.0.0
  2. #  
  3. #  Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
  4. #  
  5. #  $Id: config,v 1.39.2.6 2002/08/25 23:50:21 hal9 Exp $
  6. #  
  7. ####################################################################
  8. #                                                                  #
  9. #                      Table of Contents                           #
  10. #                                                                  #
  11. #        I. INTRODUCTION                                           #
  12. #       II. FORMAT OF THE CONFIGURATION FILE                       #
  13. #                                                                  #
  14. #        1. CONFIGURATION AND LOG FILE LOCATIONS                   #
  15. #        2. LOCAL SET-UP DOCUMENTATION                             #
  16. #        3. DEBUGGING                                              #
  17. #        4. ACCESS CONTROL AND SECURITY                            #
  18. #        5. FORWARDING                                             #
  19. #        6. WINDOWS GUI OPTIONS                                    #
  20. #                                                                  #
  21. ####################################################################
  22. #  
  23. #  
  24. #  I. INTRODUCTION
  25. #   ===============
  26. #  
  27. #  This file holds the Privoxy configuration. If you modify this file,
  28. #  you will need to send a couple of requests to the proxy before any
  29. #  changes take effect.
  30. #  
  31. #  When starting Privoxy on Unix systems, give the name of this file as
  32. #  an argument. On Windows systems, Privoxy will look for this file
  33. #  with the name 'config.txt' in the same directory where Privoxy
  34. #  is installed.
  35. #  
  36. #  
  37. #  II. FORMAT OF THE CONFIGURATION FILE
  38. #  ====================================
  39. #  
  40. #  Configuration lines consist of an initial keyword followed by a
  41. #  list of values, all separated by whitespace (any number of spaces
  42. #  or tabs). For example,
  43. #  
  44. #  actionsfile default.action
  45. #  
  46. #  Indicates that the actionsfile is named 'default.action'.
  47. #  
  48. #  The '#' indicates a comment. Any part of a line following a '#'
  49. #  is ignored, except if the '#' is preceded by a '\'.
  50. #  
  51. #  Thus, by placing a # at the start of an existing configuration line,
  52. #  you can make it a comment and it will be treated as if it weren't
  53. #  there. This is called "commenting out" an option and can be useful.
  54. #  
  55. #  Note that commenting out and option and leaving it at its default
  56. #  are two completely different things! Most options behave very
  57. #  differently when unset.  See the the "Effect if unset" explanation
  58. #  in each option's description for details.
  59. #  
  60. #  Long lines can be continued on the next line by using a `\' as the
  61. #  last character.
  62. #  
  63.  
  64. #  
  65. #  1. CONFIGURATION AND LOG FILE LOCATIONS
  66. #  =======================================
  67. #  
  68. #  Privoxy can (and normally does) use a number of other files for
  69. #  additional configuration, help and logging. This section of the
  70. #  configuration file tells Privoxy where to find those other files.
  71. #  
  72. #  The user running Privoxy, must have read permission for all
  73. #  configuration files, and write permission to any files that would
  74. #  be modified, such as log files and actions files.
  75. #  
  76.  
  77. #  
  78. #  1.1. confdir
  79. #  ============
  80. #  
  81. #  Specifies:
  82. #  
  83. #      The directory where the other configuration files are located
  84. #  
  85. #  Type of value:
  86. #  
  87. #      Path name
  88. #  
  89. #  Default value:
  90. #  
  91. #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
  92. #  
  93. #  Effect if unset:
  94. #  
  95. #      Mandatory
  96. #  
  97. #  Notes:
  98. #  
  99. #      No trailing "/", please
  100. #  
  101. #      When development goes modular and multi-user, the blocker,
  102. #      filter, and per-user config will be stored in subdirectories of
  103. #      "confdir". For now, the configuration directory structure is
  104. #      flat, except for confdir/templates, where the HTML templates
  105. #      for CGI output reside (e.g. Privoxy's 404 error page).
  106. #  
  107. confdir .
  108.  
  109. #  
  110. #  1.2. logdir
  111. #  ===========
  112. #  
  113. #  Specifies:
  114. #  
  115. #      The directory where all logging takes place (i.e. where logfile
  116. #      and jarfile are located)
  117. #  
  118. #  Type of value:
  119. #  
  120. #      Path name
  121. #  
  122. #  Default value:
  123. #  
  124. #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
  125. #  
  126. #  Effect if unset:
  127. #  
  128. #      Mandatory
  129. #  
  130. #  Notes:
  131. #  
  132. #      No trailing "/", please
  133. #  
  134. logdir .
  135.  
  136. #  
  137. #  1.3. actionsfile
  138. #  ================
  139. #  
  140. #  Specifies:
  141. #  
  142. #      The actions file(s) to use
  143. #  
  144. #  Type of value:
  145. #  
  146. #      File name, relative to confdir, without the .action suffix
  147. #  
  148. #  Default values:
  149. #  
  150. #        standard     # Internal purposes, no editing recommended
  151. #  
  152. #        default      # Main actions file
  153. #  
  154. #        user         # User customizations
  155. #  
  156. #  Effect if unset:
  157. #  
  158. #      No actions are taken at all. Simple neutral proxying.
  159. #  
  160. #  Notes:
  161. #  
  162. #      Multiple actionsfile lines are permitted, and are in fact
  163. #      recommended!
  164. #  
  165. #      The default values include standard.action, which is used
  166. #      for internal purposes and should be loaded, default.action,
  167. #      which is the "main" actions file maintained by the developers,
  168. #      and user.action, where you can make your personal additions.
  169. #  
  170. #      Actions files are where all the per site and per URL
  171. #      configuration is done for ad blocking, cookie management,
  172. #      privacy considerations, etc. There is no point in using Privoxy
  173. #      without at least one actions file.
  174. #  
  175. actionsfile standard  # Internal purpose, recommended
  176. actionsfile default   # Main actions file
  177. actionsfile user      # User customizations
  178.  
  179. #  
  180. #  1.4. filterfile
  181. #  ===============
  182. #  
  183. #  Specifies:
  184. #  
  185. #      The filter file to use
  186. #  
  187. #  Type of value:
  188. #  
  189. #      File name, relative to confdir
  190. #  
  191. #  Default value:
  192. #  
  193. #      default.filter (Unix) or default.filter.txt (Windows)
  194. #  
  195. #  Effect if unset:
  196. #  
  197. #      No textual content filtering takes place, i.e. all +filter{name}
  198. #      actions in the actions files are turned neutral.
  199. #  
  200. #  Notes:
  201. #  
  202. #      The filter file contains content modification rules that use
  203. #      regular expressions. These rules permit powerful changes on the
  204. #      content of Web pages, e.g., you could disable your favorite
  205. #      JavaScript annoyances, re-write the actual displayed text,
  206. #      or just have some fun replacing "Microsoft" with "MicroSuck"
  207. #      wherever it appears on a Web page.
  208. #  
  209. #      The +filter{name} actions rely on the relevant filter (name)
  210. #      to be defined in the filter file!
  211. #  
  212. #      A pre-defined filter file called default.filter that contains
  213. #      a bunch of handy filters for common problems is included in the
  214. #      distribution. See the section on the filter action for a list.
  215. #  
  216. filterfile default.filter
  217.  
  218. #  
  219. #  1.5. logfile
  220. #  ============
  221. #  
  222. #  Specifies:
  223. #  
  224. #      The log file to use
  225. #  
  226. #  Type of value:
  227. #  
  228. #      File name, relative to logdir
  229. #  
  230. #  Default value:
  231. #  
  232. #      logfile (Unix) or privoxy.log (Windows)
  233. #  
  234. #  Effect if unset:
  235. #  
  236. #      No log file is used, all log messages go to the console (STDERR).
  237. #  
  238. #  Notes:
  239. #  
  240. #      The windows version will additionally log to the console.
  241. #  
  242. #      The logfile is where all logging and error messages are
  243. #      written. The level of detail and number of messages are set with
  244. #      the debug option (see below).  The logfile can be useful for
  245. #      tracking down a problem with Privoxy (e.g., it's not blocking
  246. #      an ad you think it should block) but in most cases you probably
  247. #      will never look at it.
  248. #  
  249. #      Your logfile will grow indefinitely, and you will probably
  250. #      want to periodically remove it. On Unix systems, you can do
  251. #      this with a cron job (see "man cron"). For Red Hat, a logrotate
  252. #      script has been included.
  253. #  
  254. #      On SuSE Linux systems, you can place a line like
  255. #      "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
  256. #      with the effect that cron.daily will automatically archive,
  257. #      gzip, and empty the log, when it exceeds 1M size.
  258. #  
  259. #      Any log files must be writable by whatever user Privoxy is
  260. #      being run as (default on UNIX, user id is "privoxy").
  261. #  
  262. logfile logfile
  263.  
  264. #  
  265. #  1.6. jarfile
  266. #  ============
  267. #  
  268. #  Specifies:
  269. #  
  270. #      The file to store intercepted cookies in
  271. #  
  272. #  Type of value:
  273. #  
  274. #      File name, relative to logdir
  275. #  
  276. #  Default value:
  277. #  
  278. #      jarfile (Unix) or privoxy.jar (Windows)
  279. #  
  280. #  Effect if unset:
  281. #  
  282. #      Intercepted cookies are not stored at all.
  283. #  
  284. #  Notes:
  285. #  
  286. #      The jarfile may grow to ridiculous sizes over time.
  287. #  
  288. jarfile jarfile
  289.  
  290. #  
  291. #  1.7. trustfile
  292. #  ==============
  293. #  
  294. #  Specifies:
  295. #  
  296. #      The trust file to use
  297. #  
  298. #  Type of value:
  299. #  
  300. #      File name, relative to confdir
  301. #  
  302. #  Default value:
  303. #  
  304. #      Unset (commented out). When activated: trust (Unix) or trust.txt
  305. #      (Windows)
  306. #  
  307. #  Effect if unset:
  308. #  
  309. #      The whole trust mechanism is turned off.
  310. #  
  311. #  Notes:
  312. #  
  313. #      The trust mechanism is an experimental feature for building
  314. #      white-lists and should be used with care. It is NOT recommended
  315. #      for the casual user.
  316. #  
  317. #      If you specify a trust file, Privoxy will only allow access to
  318. #      sites that are named in the trustfile. You can also mark sites
  319. #      as trusted referrers (with +), with the effect that access
  320. #      to untrusted sites will be granted, if a link from a trusted
  321. #      referrer was used. The link target will then be added to the
  322. #      "trustfile". Possible applications include limiting Internet
  323. #      access for children.
  324. #  
  325. #      If you use + operator in the trust file, it may grow considerably
  326. #      over time.
  327. #  
  328. #trustfile trust
  329.  
  330. #  
  331. #  2. LOCAL SET-UP DOCUMENTATION
  332. #  =============================
  333. #  
  334. #  If you intend to operate Privoxy for more users than just yourself,
  335. #  it might be a good idea to let them know how to reach you, what
  336. #  you block and why you do that, your policies, etc.
  337. #  
  338.  
  339. #  
  340. #  2.1. user-manual
  341. #  ================
  342. #  
  343. #  Specifies:
  344. #  
  345. #      Location of the Privoxy User Manual.
  346. #  
  347. #  Type of value:
  348. #  
  349. #      A fully qualified URI
  350. #  
  351. #  Default value:
  352. #  
  353. #      Unset
  354. #  
  355. #  Effect if unset:
  356. #  
  357. #      http://www.privoxy.org/version/user-manual/ will be used,
  358. #      where version is the Privoxy version.
  359. #  
  360. #  Notes:
  361. #  
  362. #      The User Manual URI is used for help links from some of the
  363. #      internal CGI pages. The manual itself is normally packaged
  364. #      with the binary distributions, so you probably want to set this
  365. #      to a locally installed copy. For multi-user setups, you could
  366. #      provide a copy on a local webserver for all your users and use
  367. #      the corresponding URL here.
  368. #  
  369. #      Examples:
  370. #  
  371. #      Unix, in local filesystem:
  372. #  
  373. #      user-manual  file:///usr/share/doc/privoxy-2.9.18/user-manual/
  374. #  
  375. #      Any platform, on local webserver (called "local-webserver"):
  376. #  
  377. #      user-manual  http://local-webserver/privoxy-user-manual/
  378. #  
  379. #      WARNING!!!
  380. #  
  381. #          If set, this option should be the first option in the config
  382. #          file, because it is used while the config file is being read.
  383. #  
  384. #user-manual http://www.privoxy.org/user-manual/
  385.  
  386. #  
  387. #  2.2. trust-info-url
  388. #  ===================
  389. #  
  390. #  Specifies:
  391. #  
  392. #      A URL to be displayed in the error page that users will see if
  393. #      access to an untrusted page is denied.
  394. #  
  395. #  Type of value:
  396. #  
  397. #      URL
  398. #  
  399. #  Default value:
  400. #  
  401. #      Two example URL are provided
  402. #  
  403. #  Effect if unset:
  404. #  
  405. #      No links are displayed on the "untrusted" error page.
  406. #  
  407. #  Notes:
  408. #  
  409. #      The value of this option only matters if the experimental trust
  410. #      mechanism has been activated. (See trustfile above.)
  411. #  
  412. #      If you use the trust mechanism, it is a good idea to write
  413. #      up some on-line documentation about your trust policy and to
  414. #      specify the URL(s) here. Use multiple times for multiple URLs.
  415. #  
  416. #      The URL(s) should be added to the trustfile as well, so users
  417. #      don't end up locked out from the information on why they were
  418. #      locked out in the first place!
  419. #  
  420. trust-info-url  http://www.example.com/why_we_block.html
  421. trust-info-url  http://www.example.com/what_we_allow.html
  422.  
  423. #  
  424. #  2.3. admin-address
  425. #  ==================
  426. #  
  427. #  Specifies:
  428. #  
  429. #      An email address to reach the proxy administrator.
  430. #  
  431. #  Type of value:
  432. #  
  433. #      Email address
  434. #  
  435. #  Default value:
  436. #  
  437. #      Unset
  438. #  
  439. #  Effect if unset:
  440. #  
  441. #      No email address is displayed on error pages and the CGI user
  442. #      interface.
  443. #  
  444. #  Notes:
  445. #  
  446. #      If both admin-address and proxy-info-url are unset, the whole
  447. #      "Local Privoxy Support" box on all generated pages will not
  448. #      be shown.
  449. #  
  450. #admin-address privoxy-admin@example.com
  451.  
  452. #  
  453. #  2.4. proxy-info-url
  454. #  ===================
  455. #  
  456. #  Specifies:
  457. #  
  458. #      A URL to documentation about the local Privoxy setup,
  459. #      configuration or policies.
  460. #  
  461. #  Type of value:
  462. #  
  463. #      URL
  464. #  
  465. #  Default value:
  466. #  
  467. #      Unset
  468. #  
  469. #  Effect if unset:
  470. #  
  471. #      No link to local documentation is displayed on error pages and
  472. #      the CGI user interface.
  473. #  
  474. #  Notes:
  475. #  
  476. #      If both admin-address and proxy-info-url are unset, the whole
  477. #      "Local Privoxy Support" box on all generated pages will not
  478. #      be shown.
  479. #  
  480. #      This URL shouldn't be blocked ;-)
  481. #  
  482. #proxy-info-url http://www.example.com/proxy-service.html
  483.  
  484. #  
  485. #  3. DEBUGGING
  486. #  ============
  487. #  
  488. #  These options are mainly useful when tracing a problem. Note that
  489. #  you might also want to invoke Privoxy with the --no-daemon command
  490. #  line option when debugging.
  491. #  
  492.  
  493. #  
  494. #  3.1. debug
  495. #  ==========
  496. #  
  497. #  Specifies:
  498. #  
  499. #      Key values that determine what information gets logged to
  500. #      the logfile.
  501. #  
  502. #  Type of value:
  503. #  
  504. #      Integer values
  505. #  
  506. #  Default value:
  507. #  
  508. #      12289 (i.e.: URLs plus informational and warning messages)
  509. #  
  510. #  Effect if unset:
  511. #  
  512. #      Nothing gets logged.
  513. #  
  514. #  Notes:
  515. #  
  516. #      The available debug levels are:
  517. #  
  518. #          debug         1 # show each GET/POST/CONNECT request 
  519. #          debug         2 # show each connection status 
  520. #          debug         4 # show I/O status 
  521. #          debug         8 # show header parsing 
  522. #          debug        16 # log all data into the logfile 
  523. #          debug        32 # debug force feature 
  524. #          debug        64 # debug regular expression filter
  525. #          debug       128 # debug fast redirects 
  526. #          debug       256 # debug GIF de-animation 
  527. #          debug       512 # Common Log Format
  528. #          debug      1024 # debug kill pop-ups 
  529. #          debug      2048 # CGI user interface 
  530. #          debug      4096 # Startup banner and warnings.
  531. #          debug      8192 # Non-fatal errors
  532. #  
  533. #      To select multiple debug levels, you can either add them or
  534. #      use multiple debug lines.
  535. #  
  536. #      A debug level of 1 is informative because it will show you each
  537. #      request as it happens. 1, 4096 and 8192 are highly recommended
  538. #      so that you will notice when things go wrong. The other levels
  539. #      are probably only of interest if you are hunting down a specific
  540. #      problem. They can produce a hell of an output (especially 16).
  541. #  
  542. #      The reporting of fatal errors (i.e. ones which crash Privoxy)
  543. #      is always on and cannot be disabled.
  544. #  
  545. #      If you want to use CLF (Common Log Format), you should set
  546. #      "debug 512" ONLY and not enable anything else.
  547. #  
  548. debug   1    # show each GET/POST/CONNECT request
  549. debug   4096 # Startup banner and warnings
  550. debug   8192 # Errors - *we highly recommended enabling this*
  551.  
  552. #  
  553. #  3.2. single-threaded
  554. #  ====================
  555. #  
  556. #  Specifies:
  557. #  
  558. #      Whether to run only one server thread
  559. #  
  560. #  Type of value:
  561. #  
  562. #      None
  563. #  
  564. #  Default value:
  565. #  
  566. #      Unset
  567. #  
  568. #  Effect if unset:
  569. #  
  570. #      Multi-threaded (or, where unavailable: forked) operation,
  571. #      i.e. the ability to serve multiple requests simultaneously.
  572. #  
  573. #  Notes:
  574. #  
  575. #      This option is only there for debug purposes and you should
  576. #      never need to use it. It will drastically reduce performance.
  577. #  
  578. #single-threaded
  579.  
  580. #  
  581. #  4. ACCESS CONTROL AND SECURITY
  582. #  ==============================
  583. #  
  584. #  This section of the config file controls the security-relevant
  585. #  aspects of Privoxy's configuration.
  586. #  
  587.  
  588. #  
  589. #  4.1. listen-address
  590. #  ===================
  591. #  
  592. #  Specifies:
  593. #  
  594. #      The IP address and TCP port on which Privoxy will listen for
  595. #      client requests.
  596. #  
  597. #  Type of value:
  598. #  
  599. #      [IP-Address]:Port
  600. #  
  601. #  Default value:
  602. #  
  603. #      127.0.0.1:8118
  604. #  
  605. #  Effect if unset:
  606. #  
  607. #      Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
  608. #      recommended for home users who run Privoxy on the same machine
  609. #      as their browser.
  610. #  
  611. #  Notes:
  612. #  
  613. #      You will need to configure your browser(s) to this proxy address
  614. #      and port.
  615. #  
  616. #      If you already have another service running on port 8118, or
  617. #      if you want to serve requests from other machines (e.g. on your
  618. #      local network) as well, you will need to override the default.
  619. #  
  620. #      If you leave out the IP address, Privoxy will bind to all
  621. #      interfaces (addresses) on your machine and may become reachable
  622. #      from the Internet. In that case, consider using access control
  623. #      lists (ACL's, see below), and/or a firewall.
  624. #  
  625. #      If you open Privoxy to untrusted users, you will also want
  626. #      to turn off the enable-edit-actions and enable-remote-toggle
  627. #      options!
  628. #  
  629. #  Example:
  630. #  
  631. #      Suppose you are running Privoxy on a machine which has the
  632. #      address 192.168.0.1 on your local private network (192.168.0.0)
  633. #      and has another outside connection with a different address. You
  634. #      want it to serve requests from inside only:
  635. #  
  636. #        listen-address  192.168.0.1:8118
  637. #  
  638. listen-address  127.0.0.1:8118
  639.  
  640. #  
  641. #  4.2. toggle
  642. #  ===========
  643. #  
  644. #  Specifies:
  645. #  
  646. #      Initial state of "toggle" status
  647. #  
  648. #  Type of value:
  649. #  
  650. #      1 or 0
  651. #  
  652. #  Default value:
  653. #  
  654. #      1
  655. #  
  656. #  Effect if unset:
  657. #  
  658. #      Act as if toggled on
  659. #  
  660. #  Notes:
  661. #  
  662. #      If set to 0, Privoxy will start in "toggled off" mode,
  663. #      i.e. behave like a normal, content-neutral proxy where all ad
  664. #      blocking, filtering, etc are disabled. See enable-remote-toggle
  665. #      below. This is not really useful anymore, since toggling is
  666. #      much easier via the web interface than via editing the conf file.
  667. #  
  668. #      The windows version will only display the toggle icon in the
  669. #      system tray if this option is present.
  670. #  
  671. toggle  1
  672.  
  673. #  
  674. #  4.3. enable-remote-toggle
  675. #  =========================
  676. #  
  677. #  Specifies:
  678. #  
  679. #      Whether or not the web-based toggle feature may be used
  680. #  
  681. #  Type of value:
  682. #  
  683. #      0 or 1
  684. #  
  685. #  Default value:
  686. #  
  687. #      1
  688. #  
  689. #  Effect if unset:
  690. #  
  691. #      The web-based toggle feature is disabled.
  692. #  
  693. #  Notes:
  694. #  
  695. #      When toggled off, Privoxy acts like a normal, content-neutral
  696. #      proxy, i.e.  it acts as if none of the actions applied to
  697. #      any URL.
  698. #  
  699. #      For the time being, access to the toggle feature can not be
  700. #      controlled separately by "ACLs" or HTTP authentication, so that
  701. #      everybody who can access Privoxy (see "ACLs" and listen-address
  702. #      above) can toggle it for all users. So this option is not
  703. #      recommended for multi-user environments with untrusted users.
  704. #  
  705. #      Note that you must have compiled Privoxy with support for this
  706. #      feature, otherwise this option has no effect.
  707. #  
  708. enable-remote-toggle  1
  709.  
  710. #  
  711. #  4.4. enable-edit-actions
  712. #  ========================
  713. #  
  714. #  Specifies:
  715. #  
  716. #      Whether or not the web-based actions file editor may be used
  717. #  
  718. #  Type of value:
  719. #  
  720. #      0 or 1
  721. #  
  722. #  Default value:
  723. #  
  724. #      1
  725. #  
  726. #  Effect if unset:
  727. #  
  728. #      The web-based actions file editor is disabled.
  729. #  
  730. #  Notes:
  731. #  
  732. #      For the time being, access to the editor can not be controlled
  733. #      separately by "ACLs" or HTTP authentication, so that everybody
  734. #      who can access Privoxy (see "ACLs" and listen-address above)
  735. #      can modify its configuration for all users. So this option is
  736. #      not recommended for multi-user environments with untrusted users.
  737. #  
  738. #      Note that you must have compiled Privoxy with support for this
  739. #      feature, otherwise this option has no effect.
  740. #  
  741. enable-edit-actions 1
  742.  
  743. #  
  744. #  4.5. ACLs: permit-access and deny-access
  745. #  ========================================
  746. #  
  747. #  Specifies:
  748. #  
  749. #      Who can access what.
  750. #  
  751. #  Type of value:
  752. #  
  753. #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
  754. #  
  755. #      Where src_addr and dst_addr are IP addresses in dotted decimal
  756. #      notation or valid DNS names, and src_masklen and dst_masklen are
  757. #      subnet masks in CIDR notation, i.e. integer values from 2 to 30
  758. #      representing the length (in bits) of the network address. The
  759. #      masks and the whole destination part are optional.
  760. #  
  761. #  Default value:
  762. #  
  763. #      Unset
  764. #  
  765. #  Effect if unset:
  766. #  
  767. #      Don't restrict access further than implied by listen-address
  768. #  
  769. #  Notes:
  770. #  
  771. #      Access controls are included at the request of ISPs and systems
  772. #      administrators, and are not usually needed by individual
  773. #      users. For a typical home user, it will normally suffice to
  774. #      ensure that Privoxy only listens on the localhost (127.0.0.1)
  775. #      or internal (home) network address by means of the listen-address
  776. #      option.
  777. #  
  778. #      Please see the warnings in the FAQ that this proxy is not
  779. #      intended to be a substitute for a firewall or to encourage
  780. #      anyone to defer addressing basic security weaknesses.
  781. #  
  782. #      Multiple ACL lines are OK. If any ACLs are specified, then
  783. #      the Privoxy talks only to IP addresses that match at least one
  784. #      permit-access line and don't match any subsequent deny-access
  785. #      line. In other words, the last match wins, with the default
  786. #      being deny-access.
  787. #  
  788. #      If Privoxy is using a forwarder (see forward below) for a
  789. #      particular destination URL, the dst_addr that is examined is
  790. #      the address of the forwarder and NOT the address of the ultimate
  791. #      target. This is necessary because it may be impossible for the
  792. #      local Privoxy to determine the IP address of the ultimate target
  793. #      (that's often what gateways are used for).
  794. #  
  795. #      You should prefer using IP addresses over DNS names, because
  796. #      the address lookups take time. All DNS names must resolve! You
  797. #      can not use domain patterns like "*.org" or partial domain
  798. #      names. If a DNS name resolves to multiple IP addresses, only
  799. #      the first one is used.
  800. #  
  801. #      Denying access to particular sites by ACL may have undesired
  802. #      side effects if the site in question is hosted on a machine
  803. #      which also hosts other sites.
  804. #  
  805. #  Examples:
  806. #  
  807. #      Explicitly define the default behavior if no ACL and
  808. #      listen-address are set: "localhost" is OK. The absence of a
  809. #      dst_addr implies that all destination addresses are OK:
  810. #  
  811. #        permit-access  localhost
  812. #  
  813. #      Allow any host on the same class C subnet as www.privoxy.org
  814. #      access to nothing but www.example.com:
  815. #  
  816. #        permit-access  www.privoxy.org/24 www.example.com/32
  817. #  
  818. #      Allow access from any host on the 26-bit subnet 192.168.45.64
  819. #      to anywhere, with the exception that 192.168.45.73 may not
  820. #      access www.dirty-stuff.example.com:
  821. #  
  822. #        permit-access  192.168.45.64/26 
  823. #        deny-access    192.168.45.73     www.dirty-stuff.example.com
  824. #  
  825.  
  826. #  
  827. #  4.6. buffer-limit
  828. #  =================
  829. #  
  830. #  Specifies:
  831. #  
  832. #      Maximum size of the buffer for content filtering.
  833. #  
  834. #  Type of value:
  835. #  
  836. #      Size in Kbytes
  837. #  
  838. #  Default value:
  839. #  
  840. #      4096
  841. #  
  842. #  Effect if unset:
  843. #  
  844. #      Use a 4MB (4096 KB) limit.
  845. #  
  846. #  Notes:
  847. #  
  848. #      For content filtering, i.e. the +filter and +deanimate-gif
  849. #      actions, it is necessary that Privoxy buffers the entire document
  850. #      body. This can be potentially dangerous, since a server could
  851. #      just keep sending data indefinitely and wait for your RAM to
  852. #      exhaust -- with nasty consequences.  Hence this option.
  853. #  
  854. #      When a document buffer size reaches the buffer-limit, it is
  855. #      flushed to the client unfiltered and no further attempt to filter
  856. #      the rest of the document is made. Remember that there may be
  857. #      multiple threads running, which might require up to buffer-limit
  858. #      Kbytes each, unless you have enabled "single-threaded" above.
  859. #  
  860. buffer-limit 4096
  861.  
  862. #  
  863. #  5. FORWARDING
  864. #  =============
  865. #  
  866. #  This feature allows routing of HTTP requests through a chain
  867. #  of multiple proxies. It can be used to better protect privacy
  868. #  and confidentiality when accessing specific domains by routing
  869. #  requests to those domains through an anonymous public proxy (see
  870. #  e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching
  871. #  proxy to speed up browsing. Or chaining to a parent proxy may be
  872. #  necessary because the machine that Privoxy runs on has no direct
  873. #  Internet access.
  874. #  
  875. #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
  876. #  4 and SOCKS 4A protocols.
  877. #  
  878.  
  879. #  
  880. #  5.1. forward
  881. #  ============
  882. #  
  883. #  Specifies:
  884. #  
  885. #      To which parent HTTP proxy specific requests should be routed.
  886. #  
  887. #  Type of value:
  888. #  
  889. #      target_pattern http_parent[:port]
  890. #  
  891. #      where target_pattern is a URL pattern that specifies to which
  892. #      requests (i.e. URLs) this forward rule shall apply. Use /
  893. #      to denote "all URLs".  http_parent[:port] is the DNS name or
  894. #      IP address of the parent HTTP proxy through which the requests
  895. #      should be forwarded, optionally followed by its listening port
  896. #      (default: 8080). Use a single dot (.) to denote "no forwarding".
  897. #  
  898. #  Default value:
  899. #  
  900. #      Unset
  901. #  
  902. #  Effect if unset:
  903. #  
  904. #      Don't use parent HTTP proxies.
  905. #  
  906. #  Notes:
  907. #  
  908. #      If http_parent is ".", then requests are not forwarded to
  909. #      another HTTP proxy but are made directly to the web servers.
  910. #  
  911. #      Multiple lines are OK, they are checked in sequence, and the
  912. #      last match wins.
  913. #  
  914. #  Examples:
  915. #  
  916. #      Everything goes to an example anonymizing proxy, except SSL on
  917. #      port 443 (which it doesn't handle):
  918. #  
  919. #        forward   /      anon-proxy.example.org:8080 
  920. #        forward   :443   .
  921. #  
  922. #      Everything goes to our example ISP's caching proxy, except for
  923. #      requests to that ISP's sites:
  924. #  
  925. #        forward   /                  caching-proxy.example-isp.net:8000
  926. #        forward   .example-isp.net   .
  927. #  
  928.  
  929. #  
  930. #  5.2. forward-socks4 and forward-socks4a
  931. #  =======================================
  932. #  
  933. #  Specifies:
  934. #  
  935. #      Through which SOCKS proxy (and to which parent HTTP proxy)
  936. #      specific requests should be routed.
  937. #  
  938. #  Type of value:
  939. #  
  940. #      target_pattern socks_proxy[:port] http_parent[:port]
  941. #  
  942. #      where target_pattern is a URL pattern that specifies to which
  943. #      requests (i.e. URLs) this forward rule shall apply. Use / to
  944. #      denote "all URLs".  http_parent and socks_proxy are IP addresses
  945. #      in dotted decimal notation or valid DNS names (http_parent may
  946. #      be "." to denote "no HTTP forwarding"), and the optional port
  947. #      parameters are TCP ports, i.e. integer values from 1 to 64535
  948. #  
  949. #  Default value:
  950. #  
  951. #      Unset
  952. #  
  953. #  Effect if unset:
  954. #  
  955. #      Don't use SOCKS proxies.
  956. #  
  957. #  Notes:
  958. #  
  959. #      Multiple lines are OK, they are checked in sequence, and the
  960. #      last match wins.
  961. #  
  962. #      The difference between forward-socks4 and forward-socks4a
  963. #      is that in the SOCKS 4A protocol, the DNS resolution of the
  964. #      target hostname happens on the SOCKS server, while in SOCKS 4
  965. #      it happens locally.
  966. #  
  967. #      If http_parent is ".", then requests are not forwarded to another
  968. #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
  969. #      albeit through a SOCKS proxy.
  970. #  
  971. #  Examples:
  972. #  
  973. #      From the company example.com, direct connections are made to all
  974. #      "internal" domains, but everything outbound goes through their
  975. #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
  976. #      to the Internet.
  977. #  
  978. #        forward-socks4a   /              socks-gw.example.com:1080   www-cache.example-isp.net:8080 
  979. #        forward           .example.com   .
  980. #  
  981. #      A rule that uses a SOCKS 4 gateway for all destinations but no
  982. #      HTTP parent looks like this:
  983. #  
  984. #        forward-socks4   /               socks-gw.example.com:1080  .
  985. #  
  986.  
  987. #  
  988. #  6. WINDOWS GUI OPTIONS
  989. #  ======================
  990. #  
  991. #  Privoxy has a number of options specific to the Windows GUI
  992. #  interface:
  993. #  
  994.  
  995. #  If "activity-animation" is set to 1, the Privoxy icon will animate
  996. #  when "Privoxy" is active. To turn off, set to 0.
  997. #  
  998. #activity-animation   1
  999.  
  1000. #  If "log-messages" is set to 1, Privoxy will log messages to the
  1001. #  console window:
  1002. #  
  1003. #log-messages   1
  1004.  
  1005. #  If "log-buffer-size" is set to 1, the size of the log buffer,
  1006. #  i.e. the amount of memory used for the log messages displayed in
  1007. #  the console window, will be limited to "log-max-lines" (see below).
  1008. #  
  1009. #  Warning: Setting this to 0 will result in the buffer to grow
  1010. #  infinitely and eat up all your memory!
  1011. #  
  1012. #log-buffer-size 1
  1013.  
  1014. #  log-max-lines is the maximum number of lines held in the log
  1015. #  buffer. See above.
  1016. #  
  1017. #log-max-lines 200
  1018.  
  1019. #  If "log-highlight-messages" is set to 1, Privoxy will highlight
  1020. #  portions of the log messages with a bold-faced font:
  1021. #  
  1022. #log-highlight-messages 1
  1023.  
  1024. #  The font used in the console window:
  1025. #  
  1026. #log-font-name Comic Sans MS
  1027.  
  1028. #  Font size used in the console window:
  1029. #  
  1030. #log-font-size 8
  1031.  
  1032. #  "show-on-task-bar" controls whether or not Privoxy will appear as
  1033. #  a button on the Task bar when minimized:
  1034. #  
  1035. #show-on-task-bar 0
  1036.  
  1037. #  If "close-button-minimizes" is set to 1, the Windows close button
  1038. #  will minimize Privoxy instead of closing the program (close with
  1039. #  the exit option on the File menu).
  1040. #  
  1041. #close-button-minimizes 1
  1042.  
  1043. #  The "hide-console" option is specific to the MS-Win console version
  1044. #  of Privoxy.  If this option is used, Privoxy will disconnect from
  1045. #  and hide the command console.
  1046. #  
  1047. #hide-console
  1048.  
  1049. #  
  1050.